Document more structs

diff --git a/gdk/gdkclipboard.c b/gdk/gdkclipboard.c
index 63bd629ca0e02a36cf2fee855d78829bbd74f802..b2d56418a2617abe98280f3a35823201d9e2142b 100644 (file)
--- a/gdk/gdkclipboard.c
+++ b/gdk/gdkclipboard.c
@@ -55,6 +55,13 @@
  * which provides a #GInputStream object.
  */
 
+/**
+ * GdkClipboard:
+ *
+ * The GdkClipboard struct contains only private fields and should not be
+ * accessed directly.
+ */
+
 typedef struct _GdkClipboardPrivate GdkClipboardPrivate;
 
 struct _GdkClipboardPrivate

diff --git a/gdk/gdkcontentprovider.h b/gdk/gdkcontentprovider.h
index b33f266bfd77db9d5b249b9144fc4b9aa2d1969c..7af585f1a5b86e39877beebdd59d950fbf2900d0 100644 (file)
--- a/gdk/gdkcontentprovider.h
+++ b/gdk/gdkcontentprovider.h
@@ -38,6 +38,12 @@ G_BEGIN_DECLS
 
 typedef struct _GdkContentProviderClass GdkContentProviderClass;
 
+/**
+ * GdkContentProvider:
+ *
+ * Should not be directly accessed.
+ */
+
 struct _GdkContentProvider
 {
   GObject parent;

diff --git a/gdk/gdkdevice.c b/gdk/gdkdevice.c
index afb639ce57c65ef0c7f9fe7a16e49fdcb5cb75bc..fb5cf9a6bf7ff2dff52a81ce512a8de3094b4a38 100644 (file)
--- a/gdk/gdkdevice.c
+++ b/gdk/gdkdevice.c
@@ -42,6 +42,13 @@
  * relationships.
  */
 
+/**
+ * GdkDevice:
+ *
+ * The GdkDevice struct contains only private fields and
+ * should not be accessed directly.
+ */
+
 typedef struct _GdkAxisInfo GdkAxisInfo;
 
 struct _GdkAxisInfo

diff --git a/gdk/gdkdevicepad.c b/gdk/gdkdevicepad.c
index 02282f106888ad9cf0c3173b9887558be5f2a420..cfb4780209fefa213bf54f7438e2f1ae67d100cb 100644 (file)
--- a/gdk/gdkdevicepad.c
+++ b/gdk/gdkdevicepad.c
@@ -42,6 +42,13 @@
  *
  */
 
+/**
+ * GdkDevicePad:
+ *
+ * The GdkDevicePad struct contains only private fields and
+ * should not be accessed directly.
+ */
+
 #include "config.h"
 
 #include "gdkdevicepad.h"

diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c
index f7085d54fd4e7095cafd4fbd8f1fef943f330c7b..cca05e8518136e3be6c7c59144052ef062bc93a9 100644 (file)
--- a/gdk/gdkdisplay.c
+++ b/gdk/gdkdisplay.c
@@ -63,6 +63,12 @@
  * with gdk-display_get_monitor() and similar APIs.
  */
 
+/**
+ * GdkDisplay:
+ *
+ * The GdkDisplay struct contains only private field and should not
+ * be accessed directly.
+ */
 enum
 {
   PROP_0,

diff --git a/gdk/gdkdisplaymanager.c b/gdk/gdkdisplaymanager.c
index 6af57cb70499593c878300acffe04869ffe145d0..40289b97cd316ac8c37bdb6c95f788c5a203085a 100644 (file)
--- a/gdk/gdkdisplaymanager.c
+++ b/gdk/gdkdisplaymanager.c
@@ -109,6 +109,12 @@
  * ]|
  */
 
+/**
+ * GdkDisplayManager:
+ *
+ * The GdkDisplayManager struct contains only private fields and
+ * should not be accessed directly.
+ */
 
 enum {
   PROP_0,

diff --git a/gdk/gdkdnd.c b/gdk/gdkdnd.c
index 44de31c25a307bf30458ebeb9ebe0cb086e11b59..c8d0ba59317d66417b8066bd58244416c438b0d3 100644 (file)
--- a/gdk/gdkdnd.c
+++ b/gdk/gdkdnd.c
@@ -84,6 +84,13 @@ static GList *contexts = NULL;
  * the GTK+ documentation for more information.
  */
 
+/**
+ * GdkDragContext:
+ *
+ * The GdkDragContext struct contains only private fields and
+ * should not be accessed directly.
+ */
+
 /**
  * gdk_drag_context_get_display:
  * @context: a #GdkDragContext

diff --git a/gdk/gdkdrawcontext.c b/gdk/gdkdrawcontext.c
index 56629e06d210d9c5d7421ce60796cb36cf002c26..401cd6584466f8dd39f81f0897c8e23473e4c444 100644 (file)
--- a/gdk/gdkdrawcontext.c
+++ b/gdk/gdkdrawcontext.c
@@ -34,8 +34,18 @@
  * rendering methods, such as #GdkGLContext or #GdkVulkanContext. It provides
  * shared functionality between those contexts.
  *
- * You will always interact with one of those subclasses.
+ * You will always interact with one of those s.ubclasses.
+ *
+ * A GdkDrawContext is always associated with a single toplevel window.
+ */
+
+/**
+ * GdkDrawContext:
+ *
+ * The GdkDrawContext struct contains only private fields and should not
+ * be accessed directly.
  */
+
 typedef struct _GdkDrawContextPrivate GdkDrawContextPrivate;
 
 struct _GdkDrawContextPrivate {

diff --git a/gdk/gdkdrawingcontext.c b/gdk/gdkdrawingcontext.c
index 3776369fc2dec3191ab9da456d72d97115b3a1eb..31ab477706a04edc3c5d59f1f5843136217d379a 100644 (file)
--- a/gdk/gdkdrawingcontext.c
+++ b/gdk/gdkdrawingcontext.c
@@ -32,6 +32,13 @@
  * #GdkDrawingContext is available since GDK 3.22
  */
 
+/**
+ * GdkDrawingContext:
+ *
+ * The GdkDrawingContext struct contains only private fields and should not
+ * be accessed directly.
+ */
+
 #include "config.h"
 
 #include <cairo-gobject.h>

diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index 52adc9516b1aea146966668adc197513904fe9db..e01479e71b3ab152a8913170780997acf1cd7a13 100644 (file)
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -49,6 +49,19 @@
  * so these functions are rarely needed.
  */
 
+/**
+ * GdkEvent:
+ *
+ * The GdkEvent struct contains only private fields and
+ * should not be accessed directly.
+ */
+
+/**
+ * GdkEventSequence:
+ *
+ * GdkEventSequence is an opaque type representing a sequence
+ * of related touch events.
+ */
 
 typedef struct _GdkIOClosure GdkIOClosure;
 

diff --git a/gdk/gdkframeclock.c b/gdk/gdkframeclock.c
index f8450435ff198f3ed5cc528c6cbffae055539427..5e329304aba9ed3c1684056b2eb3a93b0a3d8d67 100644 (file)
--- a/gdk/gdkframeclock.c
+++ b/gdk/gdkframeclock.c
@@ -67,6 +67,13 @@
  * they will stay exactly synchronized.
  */
 
+/**
+ * GdkFrameClock:
+ *
+ * The GdkFrameClock struct contains only private fields and
+ * should not be accessed directly.
+ */
+
 enum {
   FLUSH_EVENTS,
   BEFORE_PAINT,

diff --git a/gdk/gdkframetimings.c b/gdk/gdkframetimings.c
index 7b8a3dd88cf88f0c8c42c5a63190af12d75bf8f5..6fe08a3082e797f5635a93079460ef065196217b 100644 (file)
--- a/gdk/gdkframetimings.c
+++ b/gdk/gdkframetimings.c
@@ -34,6 +34,13 @@
  * quality metrics for the application’s display, such as latency and jitter.
  */
 
+/**
+ * GdkFrameTimings:
+ *
+ * The GdkFrameTimings struct contains only private fields and
+ * should not be accessed directly.
+ */
+
 G_DEFINE_BOXED_TYPE (GdkFrameTimings, gdk_frame_timings,
                      gdk_frame_timings_ref,
                      gdk_frame_timings_unref)

diff --git a/gdk/gdkglcontext.c b/gdk/gdkglcontext.c
index 84bdd4038f52f0afc807a7d3134bd23563074e76..b0cbfdbdec599a7b70c750d05817b4c7ceb74ee3 100644 (file)
--- a/gdk/gdkglcontext.c
+++ b/gdk/gdkglcontext.c
@@ -76,6 +76,13 @@
  * that is currently set by calling gdk_gl_context_clear_current().
  */
 
+/**
+ * GdkGLContext:
+ *
+ * The GdkGLContext struct contains only private fields and
+ * should not be accessed directly.
+ */
+
 #include "config.h"
 
 #include "gdkglcontextprivate.h"

diff --git a/gdk/gdkseat.c b/gdk/gdkseat.c
index c22400324a884782027352a3a2e9edf1bb809a3b..c0b7290a165fec99ecb364236d957270409ebc39 100644 (file)
--- a/gdk/gdkseat.c
+++ b/gdk/gdkseat.c
@@ -36,6 +36,13 @@
  * that belong to a user.
  */
 
+/**
+ * GdkSeat:
+ *
+ * The GdkSeat struct contains only private fields and
+ * should not be accessed directly.
+ */
+
 typedef struct _GdkSeatPrivate GdkSeatPrivate;
 
 struct _GdkSeatPrivate

diff --git a/gdk/gdkwindow.c b/gdk/gdkwindow.c
index 97fc36abde30950d108bfe1060281cca868b8e56..9a10fceb18b37d8259fa63a8b4d1f7e3c160a1e7 100644 (file)
--- a/gdk/gdkwindow.c
+++ b/gdk/gdkwindow.c
@@ -68,6 +68,12 @@
  * each #GtkButton has a #GdkWindow associated with it.
  */
 
+/**
+ * GdkWindow:
+ *
+ * The GdkWindow struct contains only private fields and
+ * should not be accessed directly.
+ */
 
 /* Historically a GdkWindow always matches a platform native window,
  * be it a toplevel window or a child window. In this setup the